Skip to content

chore(maintenance): improve Gitpod config #1782

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Nov 2, 2023
Merged

chore(maintenance): improve Gitpod config #1782

merged 10 commits into from
Nov 2, 2023

Conversation

dreamorosi
Copy link
Contributor

Description of your changes

This PR modifies the Gitpod configuration to pin a specific base image for the workspace and configure dependencies in it.

Prior to this PR Gitpod was starting a workspace using the latest image available, which in some cases like now it's not desirable. Following the same practices that we use in other areas like dependencies and GitHub Actions, I have changed the configuration so that we are pinning a specific version of a specific Docker image identified by its sha number. I got this idea from the Python repository which does the same.

The new setup specifies a Dockerfile which uses the base workspace image and builds on top of it. I decided not to use the node image provided by Gitpod because I wanted to customize the setup of the Node.js version manager using fnm instead of nvm. In doing so I have also moved the SAM CLI install to the Dockerfile.

Related issues, RFCs

Issue number: #1781

Checklist

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my change is effective and works
  • The PR title follows the conventional commit semantics

Breaking change checklist

Is it a breaking change?: NO

  • I have documented the migration process
  • I have added, implemented necessary warnings (if it can live side by side)

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

@dreamorosi dreamorosi requested a review from a team November 2, 2023 22:32
@boring-cyborg boring-cyborg bot added the internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) label Nov 2, 2023
@dreamorosi dreamorosi self-assigned this Nov 2, 2023
@pull-request-size pull-request-size bot added the size/S PR between 10-29 LOC label Nov 2, 2023
Copy link

sonarqubecloud bot commented Nov 2, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@dreamorosi dreamorosi linked an issue Nov 2, 2023 that may be closed by this pull request
2 tasks
@dreamorosi dreamorosi merged commit 35f0c5a into main Nov 2, 2023
@dreamorosi dreamorosi deleted the chore/gitpod branch November 2, 2023 22:39
dreamorosi added a commit that referenced this pull request Nov 20, 2023
* chore(maintenance): pin node 18 in Gitpod

* chore: fix nvm & make sam install quiet

* chore: fix nvm command

* chore: switch to fem

* chore: add Dockerfile with pinned version

* chore: change to custom docker file

* chore: remove redundant command

* chore: move SAM install to docker file

* chore: remove SAM instructions from init phase

* chore: fix install command
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) size/S PR between 10-29 LOC
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Maintenance: update Gitpod config
1 participant